IsIconRefComposite

IsIconRefComposite
Header:	Icons.h		Carbon status:	Supported

Reports whether a specified IconRef has been composited.

OSErr IsIconRefComposite (
    IconRef compositeIconRef, 
    IconRef *backgroundIconRef, 
    IconRef *foregroundIconRef
);

compositeIconRef: An IconRef that you wish to test to determine whether it has been composited.
backgroundIconRef: On return, this points to the IconRef value that forms the background of the IconRef specified in the compositeIconRef parameter. If the IconRef specified in the compositeIconRef parameter is not a composite, the return value is 0.
foregroundIconRef: On return, this points to the IconRef value that forms the foreground of the IconRef specified in the compositeIconRef parameter. If the IconRef specified in the compositeIconRef parameter is not a composite, the return value is 0.

function result: A result code.

DISCUSSION

The function CompositeIconRef allows the creation of a composite IconRef from a given background IconRef and a given foreground IconRef. The IsIconRefComposite function checks a specified IconRef to determine whether it is a composite and, if so, provides the background and foreground IconRef values.

AVAILABILITY

Supported in Carbon. Available in CarbonLib 1.0 and later when IconServicesLib 8.5 or later is installed. Exported by CarbonLib 1.0 and later and by IconServicesLib 8.5 and later.